Skip to main content

Yaan AI for API

Yaan AI for API is an AI-powered engine within DevAssure that allows teams to quickly import API specifications (from Postman Collections or Swagger/OpenAPI JSON files) and automatically generate:

  • API definitions.
  • Test cases, grouped by API and endpoint including validations for headers, query params, and boundary conditions.
  • Test data for execution.

This accelerates API quality checks by eliminating manual setup and enabling instant coverage with schema validation and parameterized testing.

Yaan AI for API, available under the API menu in the side navigation, streamlines API testing by shifting from manual test creation to AI-powered auto-generation.

API Definition Creation​

Once an API specifications is provided, Yaan AI processes it and creates individual API files within the project.

Icon

Example : Using the Postman collection : SignNow API Collection

From this single imported JSON file, Yaan AI creates files such as:

  • document.api

  • document_group.api

  • oauth2_userauth.api

Each .api file contains multiple endpoints with structured details such as:

  • Endpoint URL

    • GET https://api.example.com/document/${document_id}/download
    • GET https://api.example.com/v2/documents/${document_id}/brand

  • Parameters

    • Path Parameters (e.g., document_id)
    • Query Parameters (e.g., use_hierarchy)
    • Headers (e.g., Authorization, Content-Type)
    • Request Body (if applicable)

  • Authorization

    • APIs are linked to authorization profiles (e.g., authorise.auth).
Icon

Example - Generated API Definitions​

  1. downloadDocument
    • GET https://api.example.com/document/${document_id}/download
    • Params: document_id (string), access_token (string)
    • Test Coverage Created:
      • ✅ Response Schema Validation Test
      • ✅ Header Validation (missing/invalid Authorization)

Auto-Generated Test Cases​

Yaan AI automatically generates test cases for each API endpoint. These test cases appear under the TEST CASES menu in the left navigation, grouped by API and endpoint.

Icon

Test Case Grouping​

Test Case Grouping organizes auto-generated test cases by API and endpoint for easier navigation and coverage tracking.

Example

  • For document-downloadDocument API:

    • downloadDocument-header-qp-case.api.tc
      • Tests header & query parameter variations.
      • Examples: Missing Authorization, invalid access_token, empty query values.
    • downloadDocument-response-schema-tc.api.tc
      • Validates the API response against its schema definition.
      • Ensures a file download returns the expected MIME type, size, and metadata.

  • For document-getBrandOfDocument API:

    • getBrandOfDocument-header-qp-case.api.tc
      • Tests query parameter (use_hierarchy) values: true, false, missing, invalid.
      • Validates request handling with and without headers.
    • getBrandOfDocument-response-schema-tc.api.tc
      • Verifies the returned JSON includes required fields (brandId, brandName).
      • Ensures schema consistency for both hierarchy and non-hierarchy responses.

Types of Auto-Generated Tests​

  • Response Schema Validation Tests

    • Ensures the returned JSON matches the expected schema.
    • Example: A downloadDocument response must return a valid binary/file type, while a getBrandOfDocument response must include brandId and brandName.

  • Header/Authorization Tests

    • Verifies behavior when:
      • The Authorization header is missing.
      • The token is invalid or expired.
      • Correct headers are provided.

  • Query Parameter Tests

    • Generates combinations of valid, missing, or invalid query parameters.
    • Example: use_hierarchy values are tested as true, false, empty, or an invalid string.

  • Boundary/Negative Cases (when applicable)

    • Auto-detects numeric ranges, string length limits, or invalid enum values.
    • Note: If not enough metadata is found in the API definition, no boundary set is created.